/**
 *       Copyright (c) 2012 Lukas Zaruba
 *
 *   This file is part of Robot Playground.
 *
 *   Robot Playground is free software: you can redistribute it and/or modify
 *   it under the terms of the GNU Lesser General Public License as published by
 *   the Free Software Foundation, either version 3 of the License, or
 *   (at your option) any later version.
 *
 *   Robot Playground is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU Lesser General Public License for more details.
 *
 *   You should have received a copy of the GNU Lesser General Public License
 *   along with Robot Playground. If not, see <http://www.gnu.org/licenses/>.
 */
package net.zarubsys.robotplayground.core.device;

import net.zarubsys.robotplayground.core.Environment;

/**
 * NullDevice
 * 
 * A dummy device which can be used for Modules which don't
 * need to access any device. It cannot do anything and there 
 * is nothing you have to do about it.
 *
 * @author Lukas Zaruba, lukas.zaruba@gmail.com
 */
public class NullDevice implements IDevice<EmptyDeviceConfiguration> {
	
	public static final String ID = "nullDevice";
	
	private static final NullDevice INSTANCE;
	
	static {
		INSTANCE = new NullDevice();
		INSTANCE.init(EmptyDeviceConfiguration.getInstance(), null);
	}
	
	private NullDevice() {
		// to prevent instantiation
	}
	
	/**
	 * @return initialized instance of the {@link NullDevice}
	 */
	public static NullDevice getInstance() {
		return INSTANCE;
	}

	@Override
	public void init(EmptyDeviceConfiguration configuration, Environment env) {
		// ignore
	}

	@Override
	public void close() {
		// ingore
	}

	@Override
	public String getId() {
		return ID;
	}
	
}

